Create Reviews

To create a review in the Web Client, click the New Review button on the Home screen:

You will see the Create Review Screen where you can specify information about the newly created review.

The GUI Client is used for adding items from source control management systems to Collaborator.

GUI Client Main Screen

To create a review in the GUI Client, you must add materials to a new review:

1. Select the needed SCM system from the SCM Configurations list.

   

2. Select one of the buttons below the list. The buttons are used to upload materials to a review. Different buttons are available for different SCM systems (See Main Screen for details).

3. In the ensuing dialog, choose materials you want to add to the review. Click Next.

   

4. On the Select a Review screen, select Create New Review and type its title in the Title box. Alternatively, if you don't want to create a new review, select Add to Existing Review and select a review from the list below. Click Next.

   

5. On the Select Supporting Documents screen, you can click Add and select supporting files you want to add to the review. If you don't want to add any, just click Next.

   

6. The Summary screen will show files and documents to be added to the review. Click Finish to create the review or Back to make changes.

   

Once the review is created, it will open in the Web Client, where you can specify information about the review and add participants.

To create a Collaborator review from within Visual Studio IDE, use the Collaborator > Add materials main menu item, or the Add materials command in the toolbar of the Collaborator View in Visual Studio:

The command invokes the Add to Review Wizard that will lead you through the review creation process.

When the review is created, it will be displayed in the Review Screen.

To create a Collaborator review from within Eclipse IDE, right-click on any Working Sets, Projects, Folders, or Files and select Team > Add to Review from the context menu:

This will launch the Add to Review Wizard that will lead you through the review creation process.

The Team > Add to Review command uploads local copies of selected files. Once uploaded, they will be no longer synchronized with the SCM. To denote this, the Eclipse Plug-in displays an "Unsupported SCM System or Client" warning when you try to upload the local copies of files. To upload files to a review and keep them synchronized with the SCM: In CVS, add them from the Synchronize view. In Perforce, add them from the P4 Pending Changelists view or from the P4 Submitted Changelists view. In Subversion, add them from the Synchronize view or from the History view.

When the review is created, it will be displayed in the Review Screen.

To create a review via the Command-Line Client, use the ccollab admin review create command. The command's options allow to specify general information about the review.

If you want to create a review and copy some information from another review, use the ccollab admin review copy command. The options allow specifying information to be copied, such as the list of participants, values of custom fields, and materials attached to the review.

If you didn't specify general information when creating a review or you want to change it, you can use the ccollab admin review edit command.

To add a participant via the Command-Line Client, use the ccollab admin review participant assign command.

To add a review pool assignment via the Command-Line Client, use the ccollab admin review pool create command.

To add a list of participants or pool participants to a review, use the ccollab admin review set‑participants command.
This command clears all previously assigned participants and pool participants.

To copy all the participants from one review to another, use the ccollab admin review copy‑participants command.

To remove a participant from a review, use the ccollab admin review participant remove command.

To remove a review pool assignment from a review, use the ccollab admin review pool remove command.

The process of attaching files via GUI Client is described in the Creating a review via GUI Client section.

To add review materials to the review in the Visual Studio Extension, do either of the following:

• Select the Collaborator > Add materials main menu item.

• Select the Add materials command in the toolbar of the Collaborator View in Visual Studio.

• Click the Upload button in the Review Materials section of the Review Screen.

Either of these commands will launch the Add to Review Wizard that will guide you through the process of attaching materials.

To attach materials to a review, right-click on any Working Sets, Projects, Folders, or Files and select Team > Add to Review from the context menu:

This will launch the Add to Review Wizard that will lead you through the process of attaching materials.

The Team > Add to Review command uploads local copies of selected files. Once uploaded, they will be no longer synchronized with the SCM. To denote this, the Eclipse Plug-in displays an "Unsupported SCM System or Client" warning when you try to upload the local copies of files. To upload files to a review and keep them synchronized with the SCM: In CVS, add them from the Synchronize view. In Perforce, add them from the P4 Pending Changelists view or from the P4 Submitted Changelists view. In Subversion, add them from the Synchronize view or from the History view.

You can upload the following types of content from the Web Client:

• Changes committed to a pre-configured version control system.

• Arbitrary files from your computer.

Attaching changelists via Web Client

In order to perform these steps, your Collaborator server must be connected to a version control system as described in Version Control.

To add a changelist:

1. Click the Upload button.

2. Select the name of the connected version control system from the drop-down list:

   

3. In the ensuing dialog, enter the unique IDs of the desired changelists and then click Attach.

   

You can attach any number of changelists to a single review. Also, you can attach changelists from different version control servers to a single review.

If there is an error retrieving that version or communicating with the server, you will see an error message.

Attaching Live URLs

You can attach live links to web sites. Attaching a live URL will display the live contents of the link during the review (rather than a local copy of the content). This feature is useful for accessing a document on a Wiki or document management system, particularly if you link to a specific version of that document.

To add a web link:

1. Click the Upload button.
2. Select URL from the drop-down list.
3. In the ensuing dialog, enter the desired URL and then click Attach
   
   

Notes:

• The URL must be a valid web URL, which should include the protocol specification (either http:// or https://).
• You will also see an error message if the specified URL is malformed.
• Collaborator does not check whether the specified resource is available. In fact, since it is a link, the contents and availability of the document can change at any time.

• Collaborator displays the referred resource in a frame. The server can send requested contents with anti-framing headers. You will not see the referred content in this case. Depending on the web browser you use, you will see an empty frame or an error message saying that the content cannot be displayed in a frame:

  

Attaching arbitrary files via Web Client

You can also attach any arbitrary file (images, PDFs, and binary file types) from your local hard drive:

1. Click the Upload button.

2. Select Files from the drop-down list.

3. In the ensuing dialog, choose one or more files you want to attach and then click Upload.

   

The following commands can be used to add various types of materials to a review:

To learn more about uploading arbitrary diffs from SCM systems to Collaborator, see Upload Diffs.

To move the review to the Annotating phase, click the Annotate button in the review header. To start the Inspection phase, click the Inspect button.

To move the review to the Annotating phase, click the Annotate Review button in the Next Steps section. To start the Inspection phase, click the Begin Review button.

To move the review to the Annotating phase, click the Annotate Review button in the Moving On section. To start the Inspection phase, click the Begin Review button.

To move the review to the Annotating phase, use the ccollab admin review annotate command. To start the Inspection phase, use the ccollab admin review finish command.

Select Review Actions > Delete in review header:

Click the Delete button on top of the Review Screen:

Click the Delete Review button on the General Information toolbar:

Use the ccollab admin review delete command.